home *** CD-ROM | disk | FTP | other *** search
/ Sprite 1984 - 1993 / Sprite 1984 - 1993.iso / man / cmds.fmt / idx.man < prev    next >
Text File  |  1990-07-30  |  5KB  |  133 lines
  1.  
  2.  
  3.  
  4. LID                       User Commands                       LID
  5.  
  6.  
  7.  
  8. NNAAMMEE
  9.      lid, gid, eid, aid - query id database
  10.  
  11. SSYYNNOOPPSSIISS
  12.      lliidd [--fffile] [--uun] [--eeddooxxaammssee]] patterns...
  13.  
  14.      ggiidd [--fffile] [--eeddooxxaammssee]] patterns...
  15.  
  16.      eeiidd [--fffile] [--ddooxxaammssee]] patterns...
  17.  
  18.      aaiidd [--fffile] [--ddooxxaammss]] patterns...
  19.  
  20. DDEESSCCRRIIPPTTIIOONN
  21.      These commands provide a flexible query interface to the _i_d
  22.      database.  _L_i_d does a lookup on _p_a_t_t_e_r_n_s and prints out
  23.      lines in this way:
  24.  
  25.      idname        ../hdir/hfile.h ../cdir/{cfile1,cfile2}.c
  26.  
  27.      Notice that multiple files with the same directory prefix
  28.      and suffix are concatenated in the globbing-set-notation of
  29.      _c_s_h(1).  Also notice that all of the _i_d database query com-
  30.      mands adjust the list of pathnames to be relative to your
  31.      current working directory, provided that _m_k_i_d(1) was used to
  32.      build the database, and your working directory is located
  33.      within the sub-tree covered by the _i_d database.
  34.  
  35.      If multiple names match on pattern, then there will be one
  36.      line of output per name.  The mnemonic significance of the
  37.      name is _l(_o_o_k_u_p) _i_d.
  38.  
  39.      _G_i_d does a lookup and then searches for the names it matches
  40.      in the files where they occur.  The mnemonic for this name
  41.      is _g(_r_e_p)_i_d.
  42.  
  43.      _E_i_d does a lookup, and then invokes an editor on all files
  44.      with the matched name as an initial search string.  Of
  45.      course, this name stands for _e(_d_i_t) _i_d.
  46.  
  47.      _E_i_d uses four environment variables to control its invoca-
  48.      tion of the editor.  Naturally, EEDDIITTOORR is used to locate the
  49.      editing program.  EEIIDDAARRGG is a _p_r_i_n_t_f(3S) string used to
  50.      specify the form of the initial-search-string argument.  If
  51.      the editor does not support such an argument, this variable
  52.      may be left unset.  EEIIDDLLDDEELL and EEIIDDRRDDEELL specify the form of
  53.      the left and right word-delimiters respectively.  The best
  54.      way to explain the use of these last three variables is with
  55.      an example.  Here are the proper settings for vi(1):
  56.      EIDARG='+/%s/' # initial search argument template
  57.      EIDLDEL='\<'   # left word-delimiter
  58.      EIDRDEL='\>'   # right word-delimiter
  59.  
  60.  
  61.  
  62.  
  63. Sprite v1.0                                                     1
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. LID                       User Commands                       LID
  71.  
  72.  
  73.  
  74.      _P_a_t_t_e_r_n_s may be simple alpha-numeric strings, or regular
  75.      expressions in the style of _r_e_g_c_m_p(3).  If the string con-
  76.      tains no regular-expression meta-characters, it is searched
  77.      for as a _w_o_r_d.  If the string contains meta-characters, or
  78.      if the -e argument is supplied, it is searched for as
  79.      regular-expression.
  80.  
  81.      _A_i_d produces output in the style of _l_i_d but its pattern
  82.      arguments are searched for as substrings within the identif-
  83.      iers in the database.  No regular-expression search is per-
  84.      formed, even if the pattern contains meta-characters.  The
  85.      search is conducted in an alphabetic case insensitive
  86.      manner.  The mnemonic for this name is _a(_p_r_o_p_o_s) _i_d.
  87.  
  88.      The following options are recognized:
  89.  
  90.      --fffile    Use _f_i_l_e as the database instead of the default
  91.                IIDD.
  92.  
  93.      --uun       Lists all identifiers in the database that are
  94.                non-unique within the first _n characters.  This
  95.                facility is particularly helpful when porting a
  96.                program to a system whose compiler or linker has
  97.                fewer significant characters for identifiers.
  98.  
  99.      The remaining options are for use in conjunction with
  100.      numeric patterns:
  101.  
  102.      --ddooxxaa     These options may be specified in any combination.
  103.                They limit numeric matches to specific radixes.
  104.                The --dd, --oo, and --xx options limit matches to
  105.                decimal, octal, and hexadecimal respectively.  The
  106.                --aa option is a shorthand for specifying all three
  107.                radixes.
  108.  
  109.      Searches for numbers are conducted numerically rather than
  110.      lexically, so that all representations for a given number
  111.      are potentially available from a single search.
  112.  
  113.      --mm        Merge multiple lines of output into a single line.
  114.  
  115.      --ss        Limit the results of the search to identifiers
  116.                that occur only once in the entire set of sources
  117.                covered by the database.  This option is useful
  118.                for finding identifiers that are defined but never
  119.                used.
  120.  
  121. SSEEEE AALLSSOO
  122.      mkid(1), fid(1).
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129. Sprite v1.0                                                     2
  130.  
  131.  
  132.  
  133.